﻿/*
 * Delegates - All delegate definitions used in FluentListView
 *
 * Author: Phillip Piper
 * Date: 31-March-2011 5:53 pm
 *
 * Change log:
 * v2.10
 * 2015-12-30  JPP  - Added CellRendererGetterDelegate
 * v2.?
 * 2011-03-31  JPP  - Split into its own file
 * 
 * Copyright (C) 2011-2015 Phillip Piper
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * If you wish to use this code in a closed source application, please contact phillip.piper@gmail.com.
 */

using System;
using System.Windows.Forms;
using System.Drawing;

namespace Fluent {
	#region Delegate declarations

	/// <summary>
	/// These delegates are used to extract an aspect from a row object
	/// </summary>
	public delegate object AspectGetterDelegate(object rowObject);

	/// <summary>
	/// These delegates are used to put a changed value back into a model object
	/// </summary>
	public delegate void AspectPutterDelegate(object rowObject, object newValue);

	/// <summary>
	/// These delegates can be used to convert an aspect value to a display string,
	/// instead of using the default ToString()
	/// </summary>
	public delegate string AspectToStringConverterDelegate(object value);

	/// <summary>
	/// These delegates are used to get the tooltip for a cell
	/// </summary>
	public delegate string CellToolTipGetterDelegate(OLVColumn column, object modelObject);

	/// <summary>
	/// These delegates are used to the state of the checkbox for a row object.
	/// </summary>
	/// <remarks><para>
	/// For reasons known only to someone in Microsoft, we can only set
	/// a boolean on the ListViewItem to indicate it's "checked-ness", but when
	/// we receive update events, we have to use a tristate CheckState. So we can
	/// be told about an indeterminate state, but we can't set it ourselves.
	/// </para>
	/// <para>As of version 2.0, we can now return indeterminate state.</para>
	/// </remarks>
	public delegate CheckState CheckStateGetterDelegate(object rowObject);

	/// <summary>
	/// These delegates are used to get the state of the checkbox for a row object.
	/// </summary>
	/// <param name="rowObject"></param>
	/// <returns></returns>
	public delegate bool BooleanCheckStateGetterDelegate(object rowObject);

	/// <summary>
	/// These delegates are used to put a changed check state back into a model object
	/// </summary>
	public delegate CheckState CheckStatePutterDelegate(object rowObject, CheckState newValue);

	/// <summary>
	/// These delegates are used to put a changed check state back into a model object
	/// </summary>
	/// <param name="rowObject"></param>
	/// <param name="newValue"></param>
	/// <returns></returns>
	public delegate bool BooleanCheckStatePutterDelegate(object rowObject, bool newValue);

	/// <summary>
	/// These delegates are used to get the renderer for a particular cell
	/// </summary>
	public delegate IRenderer CellRendererGetterDelegate(object rowObject, OLVColumn column);

	/// <summary>
	/// The callbacks for RightColumnClick events
	/// </summary>
	public delegate void ColumnRightClickEventHandler(object sender, ColumnClickEventArgs e);

	/// <summary>
	/// This delegate will be used to own draw header column.
	/// </summary>
	public delegate bool HeaderDrawingDelegate(Graphics g, Rectangle r, int columnIndex, OLVColumn column, bool isPressed, HeaderStateStyle stateStyle);

	/// <summary>
	/// This delegate is called when a group has been created but not yet made
	/// into a real ListViewGroup. The user can take this opportunity to fill
	/// in lots of other details about the group.
	/// </summary>
	public delegate void GroupFormatterDelegate(OLVGroup group, GroupingParameters parms);

	/// <summary>
	/// These delegates are used to retrieve the object that is the key of the group to which the given row belongs.
	/// </summary>
	public delegate object GroupKeyGetterDelegate(object rowObject);

	/// <summary>
	/// These delegates are used to convert a group key into a title for the group
	/// </summary>
	public delegate string GroupKeyToTitleConverterDelegate(object groupKey);

	/// <summary>
	/// These delegates are used to get the tooltip for a column header
	/// </summary>
	public delegate string HeaderToolTipGetterDelegate(OLVColumn column);

	/// <summary>
	/// These delegates are used to fetch the image selector that should be used
	/// to choose an image for this column.
	/// </summary>
	public delegate object ImageGetterDelegate(object rowObject);

	/// <summary>
	/// These delegates are used to draw a cell
	/// </summary>
	public delegate bool RenderDelegate(EventArgs e, Graphics g, Rectangle r, object rowObject);

	/// <summary>
	/// These delegates are used to fetch a row object for virtual lists
	/// </summary>
	public delegate object RowGetterDelegate(int rowIndex);

	/// <summary>
	/// These delegates are used to format a listviewitem before it is added to the control.
	/// </summary>
	public delegate void RowFormatterDelegate(OLVListItem olvItem);

	/// <summary>
	/// These delegates can be used to return the array of texts that should be searched for text filtering
	/// </summary>
	public delegate string[] SearchValueGetterDelegate(object value);

	/// <summary>
	/// These delegates are used to sort the listview in some custom fashion
	/// </summary>
	public delegate void SortDelegate(OLVColumn column, SortOrder sortOrder);

	/// <summary>
	/// These delegates are used to order two strings.
	/// x cannot be null. y can be null.
	/// </summary>
	public delegate int StringCompareDelegate(string x, string y);

	#endregion
}